core/androidx.core.app/[main]NotificationCompat/Action

Action

open class Action(source)

Structure to encapsulate a named action that can be shown as part of this notification. It must include an icon, a label, and a PendingIntent to be fired when the action is selected by the user. Action buttons won't appear on platforms prior to Android JELLY_BEAN.

As of Android N, action button icons will not be displayed on action buttons, but are still required and are available to notification listeners, which may display them in other contexts, for example on a wearable device.

Apps should use addAction or addAction to attach actions.

Constructors

constructor(icon: Int, @Nullable title: CharSequence, @Nullable intent: PendingIntent)

constructor(@Nullable icon: IconCompat, @Nullable title: CharSequence, @Nullable intent: PendingIntent)

Note: For devices running an Android version strictly lower than API level 23 this constructor only supports resource-ID based IconCompat objects.

Types

Builder class for Action objects.

interface Extender

Extender interface for use with extend.

@Retention(value = RetentionPolicy.SOURCE)

annotation class SemanticAction

Provides meaning to an Action that hints at what the associated PendingIntent will do.

WearableExtender

class WearableExtender : NotificationCompat.Action.Extender

Wearable extender for notification actions.

Properties

open var actionIntent: PendingIntent

Intent to send when the user invokes this action.

open var ~~icon~~: Int

Small icon representing the action.

SEMANTIC_ACTION_ARCHIVE

val SEMANTIC_ACTION_ARCHIVE: Int = 5

SemanticAction: Archive the content associated with the notification.

SEMANTIC_ACTION_CALL

val SEMANTIC_ACTION_CALL: Int = 10

SemanticAction: Call a contact, group, etc.

SEMANTIC_ACTION_DELETE

val SEMANTIC_ACTION_DELETE: Int = 4

SemanticAction: Delete the content associated with the notification.

SEMANTIC_ACTION_MARK_AS_READ

val SEMANTIC_ACTION_MARK_AS_READ: Int = 2

SemanticAction: Mark content as read.

SEMANTIC_ACTION_MARK_AS_UNREAD

val SEMANTIC_ACTION_MARK_AS_UNREAD: Int = 3

SemanticAction: Mark content as unread.

SEMANTIC_ACTION_MUTE

val SEMANTIC_ACTION_MUTE: Int = 6

SemanticAction: Mute the content associated with the notification.

SEMANTIC_ACTION_NONE

val SEMANTIC_ACTION_NONE: Int = 0

SemanticAction: No semantic action defined.

SEMANTIC_ACTION_REPLY

val SEMANTIC_ACTION_REPLY: Int = 1

SemanticAction: Reply to a conversation, chat, group, or wherever replies may be appropriate.

SEMANTIC_ACTION_THUMBS_DOWN

val SEMANTIC_ACTION_THUMBS_DOWN: Int = 9

SemanticAction: Mark content with a thumbs down.

SEMANTIC_ACTION_THUMBS_UP

val SEMANTIC_ACTION_THUMBS_UP: Int = 8

SemanticAction: Mark content with a thumbs up.

SEMANTIC_ACTION_UNMUTE

val SEMANTIC_ACTION_UNMUTE: Int = 7

SemanticAction: Unmute the content associated with the notification.

open var title: CharSequence

Title of the action.

Functions

getActionIntent

open fun getActionIntent(): PendingIntent

getAllowGeneratedReplies

open fun getAllowGeneratedReplies(): Boolean

Return whether the platform should automatically generate possible replies for this Action

getDataOnlyRemoteInputs

open fun getDataOnlyRemoteInputs(): Array<RemoteInput>

Get the list of inputs to be collected from the user that ONLY accept data when this action is sent.

open fun getExtras(): Bundle

Get additional metadata carried around with this Action.

open fun ~~getIcon~~(): Int

open fun getIconCompat(): IconCompat

Return the icon associated with this Action.

getRemoteInputs

open fun getRemoteInputs(): Array<RemoteInput>

Get the list of inputs to be collected from the user when this action is sent.

getSemanticAction

open fun getSemanticAction(): Int

Returns the SemanticAction associated with this Action.

getShowsUserInterface

open fun getShowsUserInterface(): Boolean

Return whether or not triggering this Action's PendingIntent will open a user interface.

open fun getTitle(): CharSequence

isAuthenticationRequired

open fun isAuthenticationRequired(): Boolean

Returns whether the OS should only send this action's PendingIntent on an unlocked device.

open fun isContextual(): Boolean

Returns whether this is a contextual Action, i.e.